home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 726-750 / 731 / findit / findit.doc < prev    next >
Text File  |  1995-03-18  |  13KB  |  125 lines

  1. Documentation for FindIt Version 1.0.
  2.  
  3. Copyright 1992.
  4.  
  5. Gary Smith,
  6. Atelier Films,
  7. P.O. Box 550,
  8. Hamilton,
  9. Queensland,
  10. Australia, 4007.
  11.  
  12. 17-7-92.
  13.  
  14.  
  15. FindIt 1.0 may be copied and distributed freely provided that
  16.  
  17.     1. only a nominal copying fee is charged,
  18.     2. this file is included,
  19.     3. if FindIt is included with other programs in a compilation disk
  20.        or set of disks, then a copy of these disk/s is sent to me.
  21.  
  22. FindIt 1.0 can not be used for any commercial purposes without express written permission.
  23.  
  24. FindIt requires Workbench 2.0. It will not run on Workbench 1.2/1.3.
  25.  
  26. The key features of FindIt are:
  27.  
  28.       - search multiple drives/directories
  29.       - search for 
  30.           file/directory names starting with/not starting with "text"
  31.           file/directory names containing/not containing "text"
  32.           file/directory names ending with/not ending with "text"
  33.           files/directories created on/after/before/not on "date"
  34.           files containing "text"
  35.           all of these can be combined in one search
  36.       - found files/directories can be copied, moved or deleted
  37.       - found IFF files can be viewed or printed
  38.       - found text files can be read or printed
  39.       - searches can be case sensitive/insensitive
  40.  
  41.  
  42. Installing FindIt:
  43.  
  44.     All that is required is to drag the FindIt icon into whatever drawer you wish it to be in - on either a hard or floppy disk. There are no other files needed for operation and no assigns are needed. You can save a configuration file for your convenience but FindIt does not require it to operate.
  45.     Double-click the FindIt icon to run. If running from the CLI type the program name. There are no command-line switches. FindIt can also be placed in the WBStartup drawer and FindIt will be automatically started when your Amiga is booted.
  46.  
  47.     After FindIt has been loaded, a window will appear on the Workbench screen. At the top left of the window, is a list gadget listing the directories to be searched (the Search List). On the top right of the window is a series of string and rollo gadgets where you can specify the search criteria. On the bottom of the window is a list gadget containing the found files (the Found List). Below this is a series of gadgets which allow you to perform various operations on the found files. In the middle of the window is a large 'Find It' gadget which allows you to start the search.
  48.  
  49.  
  50. Selecting Directories To Search:
  51.  
  52.     Any number of drives/directories can be selected to search through.
  53. You can type in a name in the string gadget below the Search List gadget. If you then press the <RETURN> key, the name will be added to the list.
  54. If you click in the 'Find' gadget, a file requester will appear where you can select a directory to search.
  55.     Names can be removed from the list by clicking on the name in the list gadget and then clicking on the 'Remove' gadget.
  56.     All the names in the list can be removed by clicking in the 'Clear' gadget.
  57.  
  58.  
  59. Setting The Search Criteria:
  60.  
  61.     There are four different search criteria that you can set. 
  62. These are 
  63.   - files/directories whose names start with or don't start with the specified text,
  64.   - files/directories whose names contain or don't contain the specified text,
  65.   - files/directories whose names end with or don't end with the specified text
  66.   - files/directories whose creation date is on, after, before or not on the specified date.
  67.     To set up a search, enter the text you wish in at least one of the string gadgets and then change the rollo gadget beside it to the appropriate setting.
  68.  
  69.     All of these criteria can work together or separately. If a text gadget is empty, then that criteria will be ignored. To make a search that is not dependent on the creation date, set the date rollo gadget to read 'Created Anytime'.
  70.  
  71.     For example, to search for all files that don't start with "An" and end with "pic", type "An" in the 'Starts' string gadget and set the rollo to "Doesn't Start", leave the 'Contains' string empty, type "pic" in the 'Ends' string gadget and set the rollo to "Ends", and set the 'Date' rollo to "Created Anytime".
  72.  
  73.     Below these gadgets are four other rollo gadgets which allow you to further modify the search criteria.
  74.     One of these gadgets allow you to search for 'Files Only', 'Dirs Only', 'Files & Dirs' or "Text In Files'. The 'Text In Files' option allows you to search for files that contain/don't contain the text entered in the 'Contains' string gadget. You could for example search through your "Letters" directory for all the files that contain the text "Bill Watson".
  75.     Another rollo gadget allows you to set whether to search through just the directories listed in the Search List, or through those directories and all of their sub-directories.
  76.     Another rollo gadget allows you to set whether or not the search should be Case Sensitive or Case Insensitive. If this is set to Case Insensitive, "abcde" will match "AbcdE".
  77.     The last rollo gadget sets up the type of search. "New Search" means that any entries in the Found List will be replaced by the new files. "Add To Search" means that any new found files will be added to the current entries in the Found List. 'Narrow Search' means that only those entries already in the Found List will be used for the search.
  78.  
  79.     To start a search, click in the 'Find It' gadget. A window will appear showing you the progress of the search. This window contains four gadgets. The first three allow you to Pause, Continue or Cancel the search. The last gadget allows you to close the main FindIt window during the search. This is intended to allow you access to the Workbench screen during lengthy searches.
  80.  
  81.  
  82. Operations On Found Files:
  83.  
  84.    Below the Found List gadget are gadgets which allow you to copy, move, delete, show (IFF files), read (text files), print (IFF and text files) and to get more information on the entries in the Found List. There is also an 'All Entries' gadget which allows you to work on all the found files at once.     The 'Delete' gadget allows you to delete the found files from the disk. If you have the 'Confirm Before Delete' item in the 'Options' menu is checked, then a requester will appear asking you to confirm your action. Note that you can not delete a directory that contains files or sub-directories.
  85.  
  86.     The 'Copy' gadget allows you copy the found files/directories. If you select a file to copy, then an ASL file requester will appear. Enter the file name you want to copy the selected file as. If you select a directory to copy, an ASL directory requester will appear. Enter the name of the directory you wish to copy the selected directory to. All of the files and directories in the selected directory will be copied to the new directory. 
  87.     If the 'All Entries" gadget is selected, an ASL directory requester will appear. Enter the name of the directory you wish to copy all of the entries in the Found List to. All of the files and directories (and their sub-directories) in the Found List will be copied to the new directory.
  88.  
  89.     The 'Move' gadget is the same as selecting the 'Copy' gadget and then the 'Delete' gadget. There is one restriction - you can not move a file onto a different disk. If you attempt this, a 'ERROR: rename across devices attempted' error message will appear. Move also allows you to rename a file. If you select a file to move, an ASL file requester will appear. Type in the new file name (leaving the directory name the same) and the file will be renamed.
  90.  
  91.     The 'Show' gadget allows you to display IFF picture files. The 'Show IFF Options' menu allows you to change some aspects of the display. The 'Pointer' item alloes you to show or hide the pointer. The 'Cycling' gadget allows you turn colour cycling on or off. This can also be overridden while the picture is being displayed by pressing the TAB key. If the 'Read If Not IFF' item is checked, then if the selected file is not an IFF picture, FindIt will attempt to 'Read' the file instead. See the 'Read' section below for more details. The 'Fade Speed' allows you to set a fade in/out time for the picture. This is measured in frames - 25 per second for PAL or 30 per second for NTSC. The 'Delay Time' option allows you to set the amount of time in seconds that the picture will be displayed for. If you enter a time of 0 seconds, then the picture will display until you press a key or the left mouse button.
  92.  
  93.     The 'Read" gadget allows you to read a file. Files can only be read if they contain only ASCII text. Any files containing binary code eg. program files will not be read. The file/s will be displayed in a separate window. To close this window and return to the main screen, either click in the window's Close Gadget or select 'Exit' from the menu.
  94.  
  95.     The 'Print' gadget allows you to print the selected file/s. Only IFF picture files and ASCII text files can be printed. Any other files will be ignored.
  96.  
  97.     The 'Info' gadget allows you to see some more information about the selected files and directories. This information includes the type (file or directory), the size, creation date and protection bits. If the file is a link to another file, then the file it is linked to is also shown.
  98.  
  99.  
  100. Menus:
  101.  
  102.     FindIt has three menus - "Project", "Options" and "Show IFF options".
  103.  
  104. Project Menu:
  105.  
  106.     The "Make Directory" menu item allows you to create a new directory. Enter the name of the directory you wish to create in the ASL file requester that appears when you select this menu.
  107.     You can load and save configuration files using the "Load Configuration" and "Save Configuration" menus. The configuration file is called "s:FindIt.conf". When FindIt first runs it checks to see if this file exists and reads it if it does. The configuration file contains all of the present settings of the rollo gadgets, the contents of the string gadgets, the contents of the Search List gadget and various other settings.
  108.     The 'Iconify' menu allows you to reduce FindIt to an icon on the Workbench screen. Workbench must be running for this to work. This icon functions as a AppIcon. If you drop the icon(s) for a directory (or directories) on top of the FindIt icon, those directories will be placed in the Search List and the main FindIt window will reopen. If there are already some entries in the Search List, a requester will appear asking whether you want to delete these from the Search List. If you drop an icon for a file on to the FindIt icon, then the directory that the file is in will be added to the Search List.
  109.     The 'Quit' menu allows you to quit FindIt. You can also click in the FindIt window's Close Gadget. You will be given the option to quit, to save the current configuration before quitting, or to return to the program.
  110.  
  111. Options Menu:
  112.  
  113.     If the 'Start As Workbench Icon' option is checked, then FindIt will start up as an icon on the Workbench screen (see Iconify). This is intended mainly for use when you are starting FindIt during your startup procedure and don't want the main window to open immediately. If you are placing FindIt in your WBStartup drawer, make sure that "DONOTWAIT" is included as one of your icon tooltypes. To enable this option, the menu item must be checked when the configuration file is saved. If there is no configuration file saved, then FindIt will start as it's usual window.
  114.     The 'Use Custom Screen' allows you to open FindIt on it's own screen rather than on the Workbench screen. This setting is saved in the configuration file.
  115.     The 'Date Format' option allows you change the date format to either dd-mm-yy, mm-dd-yy or yy-mm-dd. This affects the order of the 'Date" string gadgets. This setting is saved in the configuration file.
  116.     The 'Change Date To' menu allows you to change the date in the 'Date' string gadgets.
  117.     The 'Clear Found List' clears all the entries in the Found List.
  118.     The 'Save Found List As File' menu allows you to save all of the entries in the Found List gadget as a text file. A standard file requester will appear where you specify the name of the file to be saved.
  119.     The 'Add Selected Entry To Search List' adds the currently selected entry in the Found List to the Search List.
  120.     The 'Create Link To Selected Entry' menu brings up a ASL file requester which allows you to enter a file name. This file will be created and linked to the currently selected entry in the Found List. See your AmigaDos manuals for more information about links. 
  121.  
  122. Show IFF Options:
  123.  
  124.     This menu contains options for the showing of IFF pictures. These were covered earlier.
  125.